/*
 * Copyright 2011 Arie Benichou
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */

package fr.designpattern.zerosumgames.framework.service.gameplay.legalMoves.legalMove;

import fr.designpattern.zerosumgames.framework.service.gameplay.game.board.dimensions.cells.positions.PositionInterface;
import fr.designpattern.zerosumgames.framework.service.gameplay.opponents.OpponentsEnumeration;
import fr.designpattern.zerosumgames.util.NullObjectAvailableInterface;

/**
 * This is the interface for a game move.
 * 
 * TODO ? faire une factory
 * 
 * @author Arie Benichou
 * @version 0.99, 01/03/2011
 */
public interface LegalMoveInterface extends NullObjectAvailableInterface,
        Comparable<LegalMoveInterface> {

    /**
     * Returns the position.
     * 
     * @return the position
     */
    BoardPositionInterface getPosition();

    /**
     * Returns the side playing this move.
     * 
     * @return the side playing this move
     */
    OpponentsEnumeration getSide();

    void setEvaluation(final Double evaluation);

    Double getEvaluation();

    void setDepth(final int depth);

    int getDepth();

    String debug();

}